<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>websocket::seed_prng</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
<link rel="prev" href="boost__beast__websocket__async_teardown/overload2.html" title="websocket::async_teardown (2 of 2 overloads)">
<link rel="next" href="boost__beast__websocket__is_upgrade.html" title="websocket::is_upgrade">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__websocket__async_teardown/overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__websocket__is_upgrade.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="beast.ref.boost__beast__websocket__seed_prng"></a><a class="link" href="boost__beast__websocket__seed_prng.html" title="websocket::seed_prng">websocket::seed_prng</a>
</h4></div></div></div>
<p>
        <a class="indexterm" name="idm44861240694784"></a>
      </p>
<p>
        Manually provide a one-time seed to initialize the PRNG.
      </p>
<h5>
<a name="beast.ref.boost__beast__websocket__seed_prng.h0"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__websocket__seed_prng.synopsis"></a></span><a class="link" href="boost__beast__websocket__seed_prng.html#beast.ref.boost__beast__websocket__seed_prng.synopsis">Synopsis</a>
      </h5>
<p>
        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/websocket/stream.hpp" target="_top">boost/beast/websocket/stream.hpp</a>&gt;</code>
      </p>
<pre class="programlisting"><span class="keyword">void</span>
<span class="identifier">seed_prng</span><span class="special">(</span>
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">seed_seq</span><span class="special">&amp;</span> <span class="identifier">ss</span><span class="special">);</span>
</pre>
<h5>
<a name="beast.ref.boost__beast__websocket__seed_prng.h1"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__websocket__seed_prng.description"></a></span><a class="link" href="boost__beast__websocket__seed_prng.html#beast.ref.boost__beast__websocket__seed_prng.description">Description</a>
      </h5>
<p>
        This function invokes the specified seed sequence to produce a seed suitable
        for use with the pseudo-random number generator used to create masks and
        perform WebSocket protocol handshakes. If a seed is not manually provided,
        the implementation will perform a one-time seed generation using <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">random_device</span></code>.
        This function may be used when the application runs in an environment where
        the random device is unreliable or does not provide sufficient entropy.
      </p>
<h5>
<a name="beast.ref.boost__beast__websocket__seed_prng.h2"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__websocket__seed_prng.preconditions"></a></span><a class="link" href="boost__beast__websocket__seed_prng.html#beast.ref.boost__beast__websocket__seed_prng.preconditions">Preconditions</a>
      </h5>
<p>
        This function may not be called after any websocket <a class="link" href="boost__beast__websocket__stream.html" title="websocket::stream"><code class="computeroutput"><span class="identifier">stream</span></code></a> objects have been constructed.
      </p>
<h5>
<a name="beast.ref.boost__beast__websocket__seed_prng.h3"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__websocket__seed_prng.parameters"></a></span><a class="link" href="boost__beast__websocket__seed_prng.html#beast.ref.boost__beast__websocket__seed_prng.parameters">Parameters</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody><tr>
<td>
                <p>
                  <code class="computeroutput"><span class="identifier">ss</span></code>
                </p>
              </td>
<td>
                <p>
                  A reference to a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">seed_seq</span></code>
                  which will be used to seed the pseudo-random number generator.
                  The seed sequence should have at least 256 bits of entropy.
                </p>
              </td>
</tr></tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__websocket__seed_prng.h4"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__websocket__seed_prng.see_also"></a></span><a class="link" href="boost__beast__websocket__seed_prng.html#beast.ref.boost__beast__websocket__seed_prng.see_also">See Also</a>
      </h5>
<p>
        <a class="link" href="boost__beast__websocket__stream/secure_prng.html" title="websocket::stream::secure_prng"><code class="computeroutput"><span class="identifier">stream</span><span class="special">::</span><span class="identifier">secure_prng</span></code></a>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__websocket__async_teardown/overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__websocket__is_upgrade.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
